/*===========================================================================
  Copyright (C) 2014 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  This library is free software; you can redistribute it and/or modify it 
  under the terms of the GNU Lesser General Public License as published by 
  the Free Software Foundation; either version 2.1 of the License, or (at 
  your option) any later version.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License 
  along with this library; if not, write to the Free Software Foundation, 
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package net.sf.okapi.acorn.xom;

import net.sf.okapi.acorn.xom.Const;
import net.sf.okapi.acorn.xom.XUtil;

/**
 * Provides a set of utility functions for testing.
 */
public class U {

	/**
	 * Converts a given index value for an opening-code marker to its key.
	 * @param value the index value.
	 * @return the key.
	 */
	static public int kOC (int value) {
		return XUtil.toKey(Const.CODE_OPENING, Const.TAGREF_BASE+value);
	}
	
	/**
	 * Converts a given index value for an closing-code marker to its key.
	 * @param value the index value.
	 * @return the key.
	 */
	static public int kCC (int value) {
		return XUtil.toKey(Const.CODE_CLOSING, Const.TAGREF_BASE+value);
	}
	
	/**
	 * Converts a given index value for a standalone-code marker to its key.
	 * @param value the index value.
	 * @return the key.
	 */
	static public int kSC (int value) {
		return XUtil.toKey(Const.CODE_STANDALONE, Const.TAGREF_BASE+value);
	}

	/**
	 * Converts a given index value for an opening-annotation marker to its key.
	 * @param value the index value.
	 * @return the key.
	 */
	static public int kOA (int value) {
		return XUtil.toKey(Const.MARKER_OPENING, Const.TAGREF_BASE+value);
	}
	
	/**
	 * Converts a given index value for an closing-annotation marker to its key.
	 * @param value the index value.
	 * @return the key.
	 */
	static public int kCA (int value) {
		return XUtil.toKey(Const.MARKER_CLOSING, Const.TAGREF_BASE+value);
	}

}
